home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / gen_bbs / tgpc100.zip / TGPC.DOC < prev    next >
Text File  |  1996-12-20  |  5KB  |  180 lines
  1.  
  2.  
  3.  
  4.            Telegard Pipecode Converter v1.00 Documentation
  5.          
  6.            Copyright (c) 1996 Dark Zone Software.
  7.            All rights reserved.
  8.  
  9.            Utility to translate |xx style color codes in to
  10.            Telegard 3.x style `xx color codes.
  11.  
  12.            Configuration and Reference Manual
  13.            Written by David Stumpf
  14.  
  15.            Dark Zone Software
  16.            7230 White Oak Circle
  17.            Houston, Texas 77040
  18.            USA
  19.  
  20.            Internet Email : krawlur@brewich.com
  21.            World Wide Web : http://dive.woodstock.edu/~katt
  22.  
  23.  
  24.  
  25.                       ────────────────────────────────────
  26.  
  27.                        BORING (BUT NECESSARY) LEGAL STUFF
  28.  
  29.                       ────────────────────────────────────
  30.  
  31.  
  32.  
  33.  
  34. Warranty
  35. ────────
  36.  
  37.       This  package is provided as-is, without warranty of any  kind,
  38.       either  expressed or implied, and is only guaranteed to  occupy
  39.       disk  space.  In no event will the author be liable to  you  or
  40.       anyone else for any damages, including (but not limited to) any
  41.       lost profits, lost savings or other incidental or consequential
  42.       damages  arising out of the use of, or inability to  use,  this
  43.       package.
  44.  
  45.       In short:  You're on your own.  If it works for you, great;  if
  46.       not,  or if it breaks something, c'est la vie.  As  the  saying
  47.       goes,  "Use it at your own risk, but if it breaks,  *YOU*  have
  48.       the pieces."
  49.  
  50.  
  51.  
  52. Copyright Notice
  53. ────────────────
  54.  
  55.      This package and all files contained herein are Copyright (c) 1996
  56.      by  Dark  Zone  Software.   No  modifications  may be made to  any
  57.      part  of this  program  and/or  package  without  express  written
  58.      permission  from  Dark  Zone  Software.     This  package  may  be
  59.      distributed in  any  medium  as long as the  following  conditions
  60.      are  met;  a)  The package  must  be  unmodified    b)  No fees of
  61.      any  kind  may be charged for this package or directly for  access
  62.      to this package.  This software may be distrubited by CD-ROM media
  63.      and/or "pay-only" system.
  64.      
  65.      
  66.  
  67.  
  68. Background
  69. ──────────
  70.  
  71.      A little while back in the FIDO_TG (or whatever it's called) echo a
  72. disscussion came up about Tim Strike removing the |xx code support in an
  73. up-and-comming (hopefully soon) version of Telegard.  Well, this sparked
  74. complaints from a few about all the changes that will need to be made to
  75. their screens and language files.
  76.  
  77.      So, in my continuing effort to drive myself completely insane I
  78. decided to be the first to put together a color code changer.  And, here
  79. it is.  The first version at least.
  80.  
  81.  
  82. What it does
  83. ────────────
  84.  
  85.      TGPC goes through the file you specify line by line finding the old
  86. |xx style color codes, and, if found, converts them to `xx color codes.
  87. A fairly simple concept, but it took two days to get working.
  88.  
  89.  
  90. Requirements
  91. ────────────
  92.  
  93.      TGPC Requires;
  94.  
  95.      100% IBM Compatible Computer
  96.      MS-DOS v4.00 or Compatible
  97.      Telegard v3.00 or above
  98.  
  99.  
  100. Installation
  101. ────────────
  102.  
  103.      Just unzip this archive in to a directoy of your choice.  I strongly
  104. suggest a directory in your path but any directory will do.  Then, you
  105. are ready to run.  No setup required.  ;)
  106.  
  107.  
  108. Operation
  109. ─────────
  110.  
  111.      The operation of TGPC is pretty simple.  The basic command line is
  112. as follows...
  113.  
  114.      TGPC filename.ext {/L}
  115.  
  116.      The file name IS required.  The /L parameter tells TGPC to run in
  117. "Language File Mode".  In short, this causes TGPC to reset the defaults
  118. to grey on black at the start of every line.  This does NOT mean it will
  119. add the color code for this, only that if for example in your langauge
  120. file line 0300 is;
  121.  
  122. 0300 |16|12Aborted.
  123.  
  124. (bright red on black, blinking)
  125.  
  126. and line 0301 is;
  127.  
  128. 0301 ~SM~SM|15Keyboard input timeout has occurred.  Log off time was ~ST.~SM
  129.  
  130. (bright white on black, NOT blinking)
  131.  
  132. Then line 0301 will not be blinking because TGPC assumed the colors went
  133. back to grey on black.  In normal translation mode every line after 0300
  134. would be blinking until a code from |16 - |23 was givin to stop it.
  135.  
  136. * TGPC DOES make a backup of the current file before processing.
  137.  
  138.  
  139.  
  140. Versions
  141. ────────
  142.  
  143.             + Added     * Changed/Fixed   - Removed     ! Notes
  144.  
  145.                               v1.00
  146.  
  147.         !  First version
  148.  
  149.  
  150.  
  151.  
  152. Notes
  153. ─────
  154.  
  155.      I have tested this on my system and tried my best to make it screw up
  156. but is still keeps going (less causing a break in operation or rebooting
  157. or something) so it seems to work great.  But, it is ofcoarse the first
  158. version so if you encounter any problems please send mail describing them.
  159.  
  160.  
  161.  
  162. Plans for future
  163. ────────────────
  164.  
  165.      I plan to add a few more things to this in the next few months.  First
  166. I want to add an option to handle multiple file using wildcards and next
  167. I want to add an option to display the file as it is translated.  I also
  168. want to add some error handling to the code, and maybe an option to turn
  169. off the file backup unless desired.  And, if anybody comes up with any
  170. other useful options I'll strongly consider them also.
  171.  
  172.  
  173.  
  174.  
  175. Acknowlegements
  176. ───────────────
  177. Telegard is Copyright Tim Strike
  178. MS-DOS is Copyright MicroSoft
  179. IBM is Trademart International Business Machines
  180.